Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lint godoc comments #2972

Merged
merged 4 commits into from
Oct 23, 2023
Merged

Lint godoc comments #2972

merged 4 commits into from
Oct 23, 2023

Conversation

WillAbides
Copy link
Contributor

This adds linting for godoc comments. We had several cases where the method name didn't match the comment.

I had to make golangci-lint not use default exclusions in order to make it check godoc. There were only a couple of other default exclusions that affected go-github, so I only added those back.

@codecov
Copy link

codecov bot commented Oct 23, 2023

Codecov Report

Merging #2972 (8d624e3) into master (eea6e0a) will increase coverage by 0.00%.
Report is 1 commits behind head on master.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master    #2972   +/-   ##
=======================================
  Coverage   98.11%   98.11%           
=======================================
  Files         149      149           
  Lines       12790    12796    +6     
=======================================
+ Hits        12549    12555    +6     
  Misses        166      166           
  Partials       75       75           
Files Coverage Δ
github/actions_permissions_enterprise.go 100.00% <ø> (ø)
github/actions_permissions_orgs.go 100.00% <ø> (ø)
github/codesofconduct.go 100.00% <ø> (ø)
github/codespaces.go 92.40% <ø> (ø)
github/emojis.go 100.00% <ø> (ø)
github/event_types.go 100.00% <ø> (ø)
github/github.go 97.73% <100.00%> (+0.01%) ⬆️
github/issues.go 97.41% <ø> (ø)
github/messages.go 100.00% <ø> (ø)
github/meta.go 86.04% <ø> (ø)
... and 9 more

Copy link
Collaborator

@gmlewis gmlewis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thank you, @WillAbides !
LGTM.
Merging.

@gmlewis gmlewis merged commit 66ed84d into google:master Oct 23, 2023
7 checks passed
@WillAbides WillAbides deleted the lintmsgs branch October 23, 2023 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants